Delete Comment
AutomatR.Jira.Activities.DeleteComment
The "Delete Comment" activity in AutomatR's Jira package utilizes the Jira API to delete a comment associated with an issue. This activity provides a straightforward method to manage comments within Jira, allowing users to remove specific comments as part of their automation workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| Comment ID | Specifies the ID of the comment to be deleted. This is the unique identifier for an existing comment on a Jira issue. String variables containing the comment ID. |
| Ticket ID | Specifies the ID of the Jira issue for which the comment will be deleted. Either Ticket ID or Ticket Key is required. String variables containing the Jira issue ID. |
| Ticket Key | Specifies the key of the Jira issue for which the comment will be deleted. Either Ticket ID or Ticket Key is required. String variables containing the Jira issue key. |
| Misc | |
| Display Name | The display name of the activity. This field supports only strings or String variables. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Delete Comment" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Ex.: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
| Output | |
| Result | Outputs a Boolean value indicating whether the deletion of the comment was successful (True) or encountered errors (False). Variables of relevant types (e.g., Boolean variables) to store the operation result. |
How to use:
- Drag and drop the "Delete Comment" activity onto the workflow.
- Configure the properties by specifying the comment ID and either the Ticket ID or Ticket Key.
- Optionally, configure the delay.
- Execute the workflow to delete the specified comment associated with the specified Jira issue.
Example: Consider an example where the "Delete Comment" activity is used to remove a comment with the ID "123" from the Jira issue with the key "PROJ-456":
Delete Comment:
Comment ID: "123"
Ticket Key: "PROJ-456"
Result: isCommentDeleted
In this example, the activity deletes the comment with the ID "123" from the Jira issue "PROJ-456." The result of the operation (success or failure) is stored in the Boolean variable "isCommentDeleted" for further handling in the workflow.